


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Index &mdash; pytorch-seq2seq 0.1.6 documentation</title>
  

  
  
  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
        <link rel="index" title="Index"
              href="#"/>
        <link rel="search" title="Search" href="search.html"/>
    <link rel="top" title="pytorch-seq2seq 0.1.6 documentation" href="index.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> pytorch-seq2seq
          

          
          </a>

          
            
            
              <div class="version">
                0.1.6
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Notes</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html">Introduction</a></li>
</ul>
<p class="caption"><span class="caption-text">Package Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="dataset.html">Dataset</a></li>
<li class="toctree-l1"><a class="reference internal" href="util.html">Util</a></li>
<li class="toctree-l1"><a class="reference internal" href="evaluator.html">Evaluator</a></li>
<li class="toctree-l1"><a class="reference internal" href="loss.html">Loss</a></li>
<li class="toctree-l1"><a class="reference internal" href="optim.html">Optim</a></li>
<li class="toctree-l1"><a class="reference internal" href="trainer.html">Trainer</a></li>
<li class="toctree-l1"><a class="reference internal" href="models.html">Models</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">pytorch-seq2seq</a>
        
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
      <li>Index</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            

<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
 <a href="#A"><strong>A</strong></a>
 | <a href="#B"><strong>B</strong></a>
 | <a href="#C"><strong>C</strong></a>
 | <a href="#D"><strong>D</strong></a>
 | <a href="#E"><strong>E</strong></a>
 | <a href="#F"><strong>F</strong></a>
 | <a href="#G"><strong>G</strong></a>
 | <a href="#I"><strong>I</strong></a>
 | <a href="#L"><strong>L</strong></a>
 | <a href="#M"><strong>M</strong></a>
 | <a href="#N"><strong>N</strong></a>
 | <a href="#O"><strong>O</strong></a>
 | <a href="#P"><strong>P</strong></a>
 | <a href="#R"><strong>R</strong></a>
 | <a href="#S"><strong>S</strong></a>
 | <a href="#T"><strong>T</strong></a>
 | <a href="#U"><strong>U</strong></a>
 
</div>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="models.html#seq2seq.models.attention.Attention">Attention (class in seq2seq.models.attention)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="models.html#seq2seq.models.baseRNN.BaseRNN">BaseRNN (class in seq2seq.models.baseRNN)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="dataset.html#seq2seq.dataset.fields.TargetField.build_vocab">build_vocab() (seq2seq.dataset.fields.TargetField method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="util.html#seq2seq.util.checkpoint.Checkpoint">Checkpoint (class in seq2seq.util.checkpoint)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="util.html#seq2seq.util.checkpoint.Checkpoint.CHECKPOINT_DIR_NAME">CHECKPOINT_DIR_NAME (seq2seq.util.checkpoint.Checkpoint attribute)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="models.html#seq2seq.models.DecoderRNN.DecoderRNN">DecoderRNN (class in seq2seq.models.DecoderRNN)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="models.html#seq2seq.models.EncoderRNN.EncoderRNN">EncoderRNN (class in seq2seq.models.EncoderRNN)</a>
</li>
      <li><a href="loss.html#seq2seq.loss.loss.Loss.eval_batch">eval_batch() (seq2seq.loss.loss.Loss method)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="evaluator.html#seq2seq.evaluator.evaluator.Evaluator.evaluate">evaluate() (seq2seq.evaluator.evaluator.Evaluator method)</a>
</li>
      <li><a href="evaluator.html#seq2seq.evaluator.evaluator.Evaluator">Evaluator (class in seq2seq.evaluator.evaluator)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="models.html#seq2seq.models.EncoderRNN.EncoderRNN.forward">forward() (seq2seq.models.EncoderRNN.EncoderRNN method)</a>

      <ul>
        <li><a href="models.html#seq2seq.models.TopKDecoder.TopKDecoder.forward">(seq2seq.models.TopKDecoder.TopKDecoder method)</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="evaluator.html#seq2seq.evaluator.predictor.Predictor.get_decoder_features">get_decoder_features() (seq2seq.evaluator.predictor.Predictor method)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="util.html#seq2seq.util.checkpoint.Checkpoint.get_latest_checkpoint">get_latest_checkpoint() (seq2seq.util.checkpoint.Checkpoint class method)</a>
</li>
      <li><a href="loss.html#seq2seq.loss.loss.Loss.get_loss">get_loss() (seq2seq.loss.loss.Loss method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="util.html#seq2seq.util.checkpoint.Checkpoint.INPUT_VOCAB_FILE">INPUT_VOCAB_FILE (seq2seq.util.checkpoint.Checkpoint attribute)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="util.html#seq2seq.util.checkpoint.Checkpoint.load">load() (seq2seq.util.checkpoint.Checkpoint class method)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="loss.html#seq2seq.loss.loss.Loss">Loss (class in seq2seq.loss.loss)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="util.html#seq2seq.util.checkpoint.Checkpoint.MODEL_NAME">MODEL_NAME (seq2seq.util.checkpoint.Checkpoint attribute)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="loss.html#seq2seq.loss.loss.NLLLoss">NLLLoss (class in seq2seq.loss.loss)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="optim.html#seq2seq.optim.optim.Optimizer">Optimizer (class in seq2seq.optim.optim)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="util.html#seq2seq.util.checkpoint.Checkpoint.OUTPUT_VOCAB_FILE">OUTPUT_VOCAB_FILE (seq2seq.util.checkpoint.Checkpoint attribute)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="util.html#seq2seq.util.checkpoint.Checkpoint.path">path (seq2seq.util.checkpoint.Checkpoint attribute)</a>
</li>
      <li><a href="loss.html#seq2seq.loss.loss.Perplexity">Perplexity (class in seq2seq.loss.loss)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="evaluator.html#seq2seq.evaluator.predictor.Predictor.predict">predict() (seq2seq.evaluator.predictor.Predictor method)</a>
</li>
      <li><a href="evaluator.html#seq2seq.evaluator.predictor.Predictor.predict_n">predict_n() (seq2seq.evaluator.predictor.Predictor method)</a>
</li>
      <li><a href="evaluator.html#seq2seq.evaluator.predictor.Predictor">Predictor (class in seq2seq.evaluator.predictor)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="loss.html#seq2seq.loss.loss.Loss.reset">reset() (seq2seq.loss.loss.Loss method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="util.html#seq2seq.util.checkpoint.Checkpoint.save">save() (seq2seq.util.checkpoint.Checkpoint method)</a>
</li>
      <li><a href="models.html#seq2seq.models.seq2seq.Seq2seq">Seq2seq (class in seq2seq.models.seq2seq)</a>
</li>
      <li><a href="dataset.html#module-seq2seq.dataset.fields">seq2seq.dataset.fields (module)</a>
</li>
      <li><a href="evaluator.html#module-seq2seq.evaluator.evaluator">seq2seq.evaluator.evaluator (module)</a>
</li>
      <li><a href="evaluator.html#module-seq2seq.evaluator.predictor">seq2seq.evaluator.predictor (module)</a>
</li>
      <li><a href="loss.html#module-seq2seq.loss.loss">seq2seq.loss.loss (module)</a>
</li>
      <li><a href="models.html#module-seq2seq.models.attention">seq2seq.models.attention (module)</a>
</li>
      <li><a href="models.html#module-seq2seq.models.baseRNN">seq2seq.models.baseRNN (module)</a>
</li>
      <li><a href="models.html#module-seq2seq.models.DecoderRNN">seq2seq.models.DecoderRNN (module)</a>
</li>
      <li><a href="models.html#module-seq2seq.models.EncoderRNN">seq2seq.models.EncoderRNN (module)</a>
</li>
      <li><a href="models.html#module-seq2seq.models.seq2seq">seq2seq.models.seq2seq (module)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="models.html#module-seq2seq.models.TopKDecoder">seq2seq.models.TopKDecoder (module)</a>
</li>
      <li><a href="optim.html#module-seq2seq.optim.optim">seq2seq.optim.optim (module)</a>
</li>
      <li><a href="trainer.html#module-seq2seq.trainer.supervised_trainer">seq2seq.trainer.supervised_trainer (module)</a>
</li>
      <li><a href="util.html#module-seq2seq.util.checkpoint">seq2seq.util.checkpoint (module)</a>
</li>
      <li><a href="models.html#seq2seq.models.attention.Attention.set_mask">set_mask() (seq2seq.models.attention.Attention method)</a>
</li>
      <li><a href="optim.html#seq2seq.optim.optim.Optimizer.set_scheduler">set_scheduler() (seq2seq.optim.optim.Optimizer method)</a>
</li>
      <li><a href="dataset.html#seq2seq.dataset.fields.SourceField">SourceField (class in seq2seq.dataset.fields)</a>
</li>
      <li><a href="optim.html#seq2seq.optim.optim.Optimizer.step">step() (seq2seq.optim.optim.Optimizer method)</a>
</li>
      <li><a href="trainer.html#seq2seq.trainer.supervised_trainer.SupervisedTrainer">SupervisedTrainer (class in seq2seq.trainer.supervised_trainer)</a>
</li>
      <li><a href="dataset.html#seq2seq.dataset.fields.TargetField.SYM_EOS">SYM_EOS (seq2seq.dataset.fields.TargetField attribute)</a>
</li>
      <li><a href="dataset.html#seq2seq.dataset.fields.TargetField.SYM_SOS">SYM_SOS (seq2seq.dataset.fields.TargetField attribute)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="dataset.html#seq2seq.dataset.fields.TargetField">TargetField (class in seq2seq.dataset.fields)</a>
</li>
      <li><a href="models.html#seq2seq.models.TopKDecoder.TopKDecoder">TopKDecoder (class in seq2seq.models.TopKDecoder)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="trainer.html#seq2seq.trainer.supervised_trainer.SupervisedTrainer.train">train() (seq2seq.trainer.supervised_trainer.SupervisedTrainer method)</a>
</li>
      <li><a href="util.html#seq2seq.util.checkpoint.Checkpoint.TRAINER_STATE_NAME">TRAINER_STATE_NAME (seq2seq.util.checkpoint.Checkpoint attribute)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="optim.html#seq2seq.optim.optim.Optimizer.update">update() (seq2seq.optim.optim.Optimizer method)</a>
</li>
  </ul></td>
</tr></table>



           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2017, pytorch-seq2seq Contritors.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'0.1.6',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>
      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>